Making a "For internal use only" section ( internal ).
For making a bullet entry in the "For internal use only" section on the bottom of the page. The internal sections are mainly meant for the developpers of the code and therefore they can be turned ON or OFF in the generated output by setting INTERNAL_DOCS in the configuration file (see
OutputCustomization).
Syntax
\internal This comment is for internal use only.
|
Output
See below in the
For internal use only section.
About section commands
This command is a section command (also called
"Special Sections"). Common to all section commands is the fact that the section continues until a blank line or another section command is encountered.
The section commands are:
\bug, \throw, \internal, \note, \param, \remark, \sa, \todo, \warning \since
(Multiple commands are allowed yielding a bulleted list)
\author \version (Multiple commands are are comma separated in output)
- \brief, \return, \deprecated (Only intended to be used once per entity)
For internal use only.